Skip to content

docs: add note regarding unspecified behavior for 0d arrays in cumulative_sum #851

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Dec 12, 2024
Merged

docs: add note regarding unspecified behavior for 0d arrays in cumulative_sum #851

merged 1 commit into from
Dec 12, 2024

Conversation

kgryte
Copy link
Contributor

@kgryte kgryte commented Oct 31, 2024

This PR

  • Closes RFC: disallow 0-D inputs in cumulative_sum #797.
  • updates specification language to limit input arrays to those having one or more dimensions. Conforming implementations are permitted to support 0d arrays for backward-compatibility, but this should not be considered portable behavior due to ambiguities arising from expected output for 0d input (e.g., when providing include_initial, what should be the dimensionality of the output? what should happen with the axis kwarg? etc).
  • aligns the specification based on discussions in RFC: disallow 0-D inputs in cumulative_sum #797 and the Consortium workgroup meeting on May 2, 2024.

@kgryte kgryte added Narrative Content Narrative documentation content. topic: Statistics Statistics. labels Oct 31, 2024
@kgryte kgryte added this to the v2024 milestone Oct 31, 2024
This was referenced Oct 31, 2024
Closed
Merged
@kgryte kgryte added Needs Review Pull request which needs review. and removed Needs Review Pull request which needs review. labels Dec 12, 2024
@kgryte
Copy link
Contributor Author

kgryte commented Dec 12, 2024

As no objections have been raised for this PR and the proposed change already discussed during workgroup meetings, I'll go ahead and merge. Any further changes can be addressed in follow-up PRs...

@kgryte kgryte merged commit 5cdcf75 into data-apis:main Dec 12, 2024
3 checks passed
@kgryte kgryte deleted the 0d-cumulative-sum branch December 12, 2024 09:13
@antonwolfy antonwolfy mentioned this pull request Feb 5, 2025
Open
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
Narrative Content Narrative documentation content. topic: Statistics Statistics.
Projects
None yet
Milestone
v2024
Development

Successfully merging this pull request may close these issues.

RFC: disallow 0-D inputs in cumulative_sum
1 participant
@kgryte